Setting Amazon Products Tasks
This endpoint provides results from Amazon product listings according to the specified keyword (product name), location, and language parameters.
This endpoint provides results from Amazon product listings according to the specified keyword (product name), location, and language parameters.
Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-dashboard
<?php // You can download this file from here https://cdn.dataforseo.com/v3/examples/php/php_RestClient.zip require('RestClient.php'); $api_url = 'https://api.dataforseo.com/'; // Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-dashboard $client = new RestClient($api_url, null, 'login', 'password'); $post_array = array(); // example #1 - a simple way to set a task // this way requires you to specify a location, a language of search, and a keyword. $post_array[] = array( "location_name" => "United States", "language_name" => "English (United States)", "keyword" => "shoes" ); // example #2 - a way to set a task with additional parameters // high priority allows us to complete a task faster, but you will be charged more money. // after a task is completed, we will send a GET request to the address you specify. Instead of $id and $tag, you will receive actual values that are relevant to this task. $post_array[] = array( "location_name" => "United States", "language_name" => "English (United States)", "keyword" => "shoes", "priority" => 2, "tag" => "some_string_123", "pingback_url" => 'https://your-server.com/pingscript?id=$id&tag=$tag' ); // example #3 - an alternative way to set a task // after a task is completed, we will send the results according to the address you set in the 'postback_url' field. $post_array[] = array( "location_name" => "United States", "language_name" => "English (United States)", "keyword" => "shoes", "postback_data" => "html", "postback_url" => "https://your-server.com/postbackscript" ); // this example has a 3 elements, but in the case of large number of tasks - send up to 100 elements per POST request if (count($post_array) > 0) { try { // POST /v3/merchant/amazon/products/task_post $result = $client->post('/v3/merchant/amazon/products/task_post', $post_array); print_r($result); // do something with post result } catch (RestClientException $e) { echo "\n"; print "HTTP code: {$e->getHttpCode()}\n"; print "Error code: {$e->getCode()}\n"; print "Message: {$e->getMessage()}\n"; print $e->getTraceAsString(); echo "\n"; } } $client = null; ?>
The above command returns JSON structured like this:
{ "version": "0.1.20200416", "status_code": 20000, "status_message": "Ok.", "time": "0.1429 sec.", "cost": 0.003, "tasks_count": 1, "tasks_error": 0, "tasks": [ { "id": "04171413-0696-0179-0000-9bd2c0b2bba2", "status_code": 20100, "status_message": "Task Created.", "time": "0.0160 sec.", "cost": 0.003, "result_count": 0, "path": [ "v3", "merchant", "amazon", "products", "task_post" ], "data": { "api": "merchant", "function": "products", "se": "amazon", "language_code": "en_US", "location_code": 2840, "keyword": "shoes", "priority": 2, "se_type": "organic", "device": "desktop", "os": "windows" }, "result": null } ] }
All POST data should be sent in the JSON format (UTF-8 encoding). Task setting is done using the POST method. When setting a task, you should send all task parameters in the task array of the generic POST array. You can send up to 2000 API calls per minute, with each POST call containing no more than 100 tasks. If your POST call contains over 100 tasks, the tasks over this limit will return the 40006
error.
You can retrieve the results of completed tasks using the unique task identifier id
. Alternatively, we can send them to you as soon as they are ready if you specify the postback_url
or pingback_url
when setting a task. Note that if your server doesn’t respond within 10 seconds, the connection will be aborted by timeout, and the task will be transferred to the ‘Tasks Ready’ list. The error code and message depend on your server’s configuration. See Help Center to learn more about using pingbacks and postbacks with DataForSEO APIs.
Below you will find a detailed description of the fields you can use for setting a task.
Description of the fields for setting a task:
Field name | Type | Description |
---|---|---|
keyword |
string | keyword required field you can specify up to 700 characters in this field all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your keyword , please specify it as “%25”;
learn more about rules and limitations of |
url |
string | direct URL of the search query optional field you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method. example: https://www.amazon.com/s/?field-keywords=shoes&language=en_US |
priority |
integer | task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority |
location_name |
string | full name of search engine location required field if you don’t specify location_code or location_coordinate if you use this field, you don’t need to specify location_code or location_coordinate you can receive the list of available locations with their location_name parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/locations example: HA1,England,United Kingdom |
location_code |
integer | search engine location code required field if you don’t specify location_name or location_coordinate if you use this field, you don’t need to specify location_name or location_coordinate you can receive the list of available locations with their location_code parameters by making a separate request to thehttps://api.dataforseo.com/v3/merchant/amazon/locations example: 9045969 |
location_coordinate |
string | GPS coordinates of a location required field if you don’t specify location_name or location_code if you use this field, you don’t need to specify location_name or location_code location_coordinate parameter should be specified in the “latitude,longitude,radius” formatthe maximum number of decimal digits for “latitude” and “longitude”: 7 the minimum value for “radius”: 199.9 example: 53.476225,-2.243572,200 |
language_name |
string | full name of search engine language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name parameters by making a separate request to thehttps://api.dataforseo.com/v3/merchant/amazon/languages example: English (United Kingdom) |
language_code |
string | search engine language code required field if you don’t specify language_name if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/languages example: en_GB |
se_domain |
string | search engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: amazon.com , amazon.co.uk , amazon.fr , etc. |
depth |
integer | parsing depth optional field number of results to be retrieved from the Amazon results page default value: 100 max value: 700 Note: your account will be billed per each results page containing up to 100 results; thus, setting a depth above 100 may result in additional charges if the search engine returns more than 100 results;if the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance |
max_crawl_pages |
integer | page crawl limit optional field number of search results pages to crawl max value: 7 Note: the max_crawl_pages and depth parameters complement each other;learn more at our help center |
search_param |
string | additional parameters of the search query optional field you can use the following Amazon search URL parameters for customizing the search example: &low-price=52 – search for products that cost more than 52 USD;&high-price=45 – search for products that cost less than 45 USD;&sort=relevancerank – sort results by relevance;&sort=featured-rank – sort results by featured products;&sort=price-asc-rank – sort by ascending price;&sort=price-desc-rank – sort by descending price;&sort=review-rank – sort by the average customer reviews value;&sort=date-desc-rank – sort by the newest arrival
|
department |
string | amazon product department optional field specify one of the following amazon departments for extracting product listings: "Arts & Crafts" , "Automotive" , "Baby" , "Beauty & Personal Care" , "Books" , "Computers" , "Digital Music" , "Electronics" , "Kindle Store" , "Prime Video" , "Women's Fashion" , "Men's Fashion" , "Girls' Fashion" , "Boys' Fashion" , "Deals" , "Health & Household" , "Home & Kitchen" , "Industrial & Scientific" , "Luggage" , "Movies & TV" , "Music, CDs & Vinyl" , "Pet Supplies" , "Software" , "Sports & Outdoors" , "Tools & Home Improvement" , "Toys & Games" , "Video Games" |
price_min |
integer | minimum product price optional field minimum price of the returned products listed on Amazon for the specified query example: 5 |
price_max |
integer | maximum product price optional field maximum price of the returned products listed on Amazon for the specified query example: 100 |
sort_by |
string | results sorting rules optional field the following sorting rules are supported: relevance , price_low_to_high , price_high_to_low , featured , avg_customer_review , newest_arrival example: sort_by:"relevance" |
tag |
string | user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response |
postback_url |
string | return URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded;i.a., the # character will be encoded into %23
learn more on our Help Center |
postback_data |
string | postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: advanced , html |
pingback_url |
string | notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded;i.a., the # character will be encoded into %23
learn more on our Help Center |
As a response of the API server, you will receive JSON-encoded data containing a tasks
array with the information specific to the set tasks.
Description of the fields in the results array:
Field name | Type | Description |
---|---|---|
version |
string | the current version of the API |
status_code |
integer | general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions |
status_message |
string | general informational message you can find the full list of general informational messages here |
time |
string | execution time, seconds |
cost |
float | total tasks cost, USD |
tasks_count |
integer | the number of tasks in the tasks array |
tasks_error |
integer | the number of tasks in the tasks array returned with an error |
tasks |
array | array of tasks |
id |
string | unique task identifier in our system in the Universally unique identifier (UUID) format |
status_code |
integer | status code of the task generated by DataForSEO; can be within the following range: 10000-60000 |
status_message |
string | informational message of the task |
time |
string | execution time, seconds |
cost |
float | cost of the task, USD |
result_count |
integer | number of elements in the result array |
path |
array | URL path |
data |
object | contains the parameters specified in the POST request |
result |
array | array of results in this case, the value will be null |